graphql-language-service-parser

What is graphql-language-service-parser?

The graphql-language-service-parser npm package provides tools for parsing GraphQL queries and schemas. It is useful for building GraphQL language services, such as syntax highlighting, auto-completion, and error checking in IDEs.

What are graphql-language-service-parser's main functionalities?

Parsing GraphQL Queries

This feature allows you to parse a GraphQL query string into an Abstract Syntax Tree (AST). The AST can then be used for further analysis or manipulation.

const { parse } = require('graphql-language-service-parser');
const query = `{
  user(id: "1") {
    name
    age
  }
}`;
const ast = parse(query);
console.log(JSON.stringify(ast, null, 2));

Handling Syntax Errors

This feature helps in identifying and handling syntax errors in GraphQL queries. The parser throws an error if the query is not syntactically correct, which can be caught and handled appropriately.

const { parse } = require('graphql-language-service-parser');
const query = `{
  user(id: "1") {
    name
    age
  }
`;
try {
  const ast = parse(query);
} catch (error) {
  console.error('Syntax Error:', error.message);
}

Locating Nodes in AST

This feature allows you to locate specific nodes in the AST based on a character offset. It is useful for features like syntax highlighting and error reporting in IDEs.

const { parse, getLocation } = require('graphql-language-service-parser');
const query = `{
  user(id: "1") {
    name
    age
  }
}`;
const ast = parse(query);
const location = getLocation(query, 10);
console.log(location);

Other packages similar to graphql-language-service-parser

graphql

The 'graphql' package is the reference implementation of GraphQL for JavaScript. It includes a parser, but also provides a complete suite of tools for building GraphQL servers and clients. It is more comprehensive compared to graphql-language-service-parser, which focuses specifically on parsing and language services.

graphql-tools

The 'graphql-tools' package provides a set of utilities for building and manipulating GraphQL schemas. While it includes some parsing capabilities, its primary focus is on schema stitching, mocking, and other schema-related tasks. It complements graphql-language-service-parser by offering higher-level schema manipulation features.

README

graphql-language-service-parser

API Docs Discord Channel

An online immutable parser for GraphQL, designed to be used as part of syntax-highlighting and code intelligence tools such as for the GraphQL Language Service and codemirror-graphql.